Add Profile

Route

/v2/streaming/profiles

Description

Create a new streaming profile with the provided configuration. Profiles define what data to stream and how to stream it.

Method

POST

Inputs

Parameter	Type	Required	Description
name	string	Yes	Human-readable name for the profile
description	string	No	Detailed description of the profile
sources	array[Source]	Yes	Data sources to stream
destination_id	string	Yes	Target destination ID
count_threshold	integer	No	Batch size threshold (ignored for streaming destinations)
delay_threshold	string	No	Batch delay threshold (e.g., "10s")
state	string	No	Profile state (active, stopped, paused)
scope_id	string	No	Scope identifier
config	object	No	Profile configuration

Request Body

{
  "name": "Security Events Stream",
  "description": "Stream security incidents to SIEM",
  "sources": [
    {
      "type": "incidents"
    }
  ],
  "destination_id": "dest-456",
  "count_threshold": 1000,
  "delay_threshold": "10s",
  "state": "active",
  "scope_id": "scope-789",
  "config": {
    "include_ai_summary": true
  }
}

Output

Field	Type	Description
resources	array[Profile]	Array containing the created profile
errors	array[Error]	Any errors encountered

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "resources": [
    {
      "id": "profile-123",
      "name": "Security Events Stream",
      "description": "Stream security incidents to SIEM",
      "sources": [
        {
          "type": "incidents"
        }
      ],
      "destination_id": "dest-456",
      "count_threshold": 1000,
      "delay_threshold": "10s",
      "state": "active",
      "dead_letter_state": "ready",
      "scope_id": "scope-789",
      "config": {
        "include_ai_summary": true
      }
    }
  ],
  "errors": []
}